Skip to main content

MongoDB API

Samples Overview​

Qarbine provides a wide variety of sample templates, and queries. Some are application oriented examples, while others are database administrator (DBA) oriented.

Below are a few of the many component samples to consider. Review the Qarbine Catalog for the latest components.

See the latest set of components in the folder depicted below.

  

  

  

Note that many of these components are valid for any database supporting the MongoDB API other than MongoDB, Inc. such as CosmosDB and Singlestore Kai.

Databases​

This template is at “example/MongoDB/DBA/All databases”. Sample output is shown below.

  

Databases and Collections​

This template is at “example/MongoDB/DBA/All databases and their collections”. Sample output is shown below.

  

Clicking the button shows some details about the MongoDB collection.

  

General Schema​

This general purpose template is at “Qarbine_admin/Cached schemas for prompted data service”. It displays information on all of the cached schemas. These schemas are saved as users interact with the data tools such as the Data Source Designer, Query by Example, and Report by Example. If a particular collection is not shown in the output, simply open up one of these tools and select it from the collection drop down to create it. Then rerun the template.

Running the template prompts for a data service.

  

Below are sample snippets from running the template.

      

System Roles​

This template is at “example/MongoDB/DBA/System roles for prompted data service”. It provides information on the defined MongoDB system roles. The initial prompt is shown below.

  

Choose your desired MongoDB data service from the drop down. The “admin” database must be chosen for this template.

  

Below is a sample snippet from running the template.

  

The data service must have appropriate permissions to access MongoDB. If not then the following is shown. The Qarbine administrator can limit which data services are visible for a particular user.

  

Another template at “example/MongoDB/DBA/System roles and details for prompted data service” formats the information in a different manner as shown below.

  

System Users​

This template is at “example/MongoDB/DBA/System users for prompted data service”. It provides information on the defined MongoDB users. The initial prompt is shown below.

  

Choose your desired MongoDB data service from the drop down. The “admin” database must be chosen for this template.

  

Below is a sample snippet from running the template.